#!/bin/bash
#
# Runs a specified probe.
#
# Author:   Dr. Mike Murphy (mmurphy2@coastal.edu)
# Revision: 19 November 2013
#
#   Copyright 2013 Coastal Carolina University
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#


## p_cmd_run_probe_help
##
## Echoes help information for the run_probe command. Returns 0.
##
function p_cmd_run_probe_help() {
	cat << EOF
Usage: pulley run_probe <probe name> [--help]

Runs the probe specified by <probe name>, exiting with the status provided
by that probe (or another non-zero status if an error occurs). If the probe
option --help is given, displays probe help instead.
EOF
	return 0
}


## p_cmd_run_probe_summary
##
## Echoes summary information for the run_probe command. Returns 0.
##
function p_cmd_run_probe_summary() {
	echo "Runs a specified probe"
	return 0
}


## p_cmd_run_probe
##
## Implements the run_probe command, shooting the author for not updating
## this documentation message. Returns 0 on success, non-zero on failure.
##
function p_cmd_run_probe() {
	local status=0
	
	if [[ $# -lt 1 ]]; then
		echo "Usage: pulley run_probe <probe name> [--help]"
		status=2
	else
		enable_probe "$1"
		status=$?
	
		if ((status == 0)); then
			if [[ "$2" == "--help" ]]; then
				probe_help "$1"
				status=$?
			else
				run_probe "$1"
				status=$?
			fi
		else
			echo "Unknown probe: $1"
		fi
	fi
	
	return ${status}
}
